/*
 * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
 * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */

package javax.security.auth;

/**
 * Objects such as credentials may optionally implement this
 * interface to provide the capability to refresh itself.
 * For example, a credential with a particular time-restricted lifespan
 * may implement this interface to allow callers to refresh the time period
 * for which it is valid.
 *
 * @see javax.security.auth.Subject
 */
public interface Refreshable {

  /**
   * Determine if this {@code Object} is current.
   *
   * <p>
   *
   * @return true if this {@code Object} is currently current, false otherwise.
   */
  boolean isCurrent();

  /**
   * Update or extend the validity period for this
   * {@code Object}.
   *
   * <p>
   *
   * @throws SecurityException if the caller does not have permission to update or extend the
   * validity period for this {@code Object}. <p>
   * @throws RefreshFailedException if the refresh attempt failed.
   */
  void refresh() throws RefreshFailedException;
}
